Skip to content

docs: remove compliance claims and fix Mermaid diagram line breaks#12

Merged
spbsoluble merged 2 commits into
mainfrom
docs/remove-compliance-claims
Jun 16, 2026
Merged

docs: remove compliance claims and fix Mermaid diagram line breaks#12
spbsoluble merged 2 commits into
mainfrom
docs/remove-compliance-claims

Conversation

@spbsoluble

Copy link
Copy Markdown
Collaborator

Summary

  • Remove "satisfying SOX audit requirements" claim from the architecture docs — we describe what the plugin does (pre-intent logging before API calls) without asserting compliance with any audit standard we are not certified against
  • Fix all Mermaid diagram \n sequences rendering as literal text — replace with <br/>, add quotes to flowchart node labels that use HTML entities, and collapse edge labels that had embedded newlines to single-line text

Changes are made in both docsource/architecture.md (source of truth) and README.md (generated copy).

We describe what the plugin does (pre-intent logging) without asserting
compliance with any audit standard we are not certified against.
Mermaid renders literal \n in diagram labels as text. Replace with
<br/> throughout all sequence and flowchart diagrams. Also quote
flowchart node labels that use HTML entities, and collapse edge labels
that had embedded newlines to single-line text.
@spbsoluble spbsoluble merged commit fb6e414 into main Jun 16, 2026
26 checks passed
@spbsoluble spbsoluble deleted the docs/remove-compliance-claims branch June 16, 2026 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant